home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / valen110.zip / VALENCE.DOC < prev    next >
Text File  |  1993-04-01  |  41KB  |  829 lines

  1. \WHValence QWK Door v. 1.1 by William McBrine
  2. Copyright (c) 1993 Iconoclast Software
  3.  
  4.  
  5.                      \BL:\RD*\BL:\RD*\BL:\RD*\BL: USER DOCUMENTATION :\RD*\BL:\RD*\BL:\RD*\BL:
  6.  
  7.  
  8. \LB:::: \WHINTRODUCTION\LB ::::\NO
  9.  
  10. Welcome to Valence, the powerful new QWK door for Searchlight. This program
  11. will allow you to read and reply to messages offline, with all the
  12. convenience and power of Searchlight, and then some. It's packed with
  13. features. Writing them is more fun than writing about them, and I'm pressed
  14. for time, so I'll try to make this summary brief. To find out more about the
  15. door, explore it. I've tried to make it fairly simple to use.
  16.  
  17. I hope you enjoy using it as much as I enjoyed writing it.
  18.  
  19.  
  20. \LB:::: \WHQUICK START\LB ::::\NO
  21.  
  22. (No pun intended.) Just run the door, Download, answer "Y" when prompted,
  23. and enjoy! There is no mandatory setup. There are slews of options, but they
  24. all have default values. You can start QWKing right away, then go back and
  25. explore the options when you're more comfortable with it.
  26.  
  27. Ask your sysop or someone who you know uses offline mail for help on setting
  28. up a "Reader" program. They're all different, but pretty simple really. If
  29. you're game, just download one and try it. There should be at least one
  30. available for download on \%s.
  31.  
  32. If you don't want to fool with a reader program yet, you can try Valence in
  33. Text mode. (I actually programmed this part first.) This is mainly intended
  34. as a preview, or for use with systems that don't have QWK Readers, but it's
  35. pretty nice as is. In fact, I honestly would rather read Text packets from
  36. Valence than QWK packets from some other doors I've been inflicted with.
  37.  
  38. Note that the file MESSAGES.TXT will actually be an ANSI file, unless you
  39. turn off color codes in the Options section.
  40.  
  41.  
  42. \LB:::: \WHDOWNLOAD\LB ::::\NO
  43.  
  44. You can download in either Text or QWK packet mode (this file, whether
  45. you're reading it as a Bulletin or a help screen, is an example of what the
  46. text mode looks like). Downloaded packets include - at your option - new
  47. mail and messages, new bulletins, a system news file (if the sysop has
  48. provided for one), a list of new files, a SESSION.TXT file, and three
  49. pointer files.
  50.  
  51. The first time you download, you'll see the prompt:
  52.  
  53. The subboard list has been changed since your last download.
  54. Please upload any existing .REP files before proceeding.
  55.  
  56. Proceed? (Y/N)
  57.  
  58. If you have any packets from other/previous QWK doors that you want to
  59. upload to Valence, answer "N" to this prompt, and go back and upload them
  60. first. Otherwise, go ahead... later, you may see this prompt again, when the
  61. sysop has added or deleted subboards, or your access has changed. When you
  62. do, it's important that you upload the older replies first, or they may go
  63. to the wrong subboards. This is the one negative side effect of Valence's
  64. handling of conference numbers (see below for more info). On the up side,
  65. you'll always know when subboards are added to the board. :-)
  66.  
  67. Next you'll see
  68.  
  69. Copying WELCOME
  70.  
  71. (which may or may not appear, and may be followed by NEWS and/or GOODBYE)
  72.  
  73. and then scans for new bulletins, messages, and files. Any new bulletins
  74. found are listed by number. For the new message display and new files
  75. display, you have a choice of several display modes. By default, you get a
  76. screenful of numbers while message scanning, and the area descriptions while
  77. file scanning. Other options are descibed later in this document.
  78.  
  79. If you reach the maximum number of messages per packet, or the maximum
  80. number of messages in any subboard (these are user-selectable; see below),
  81. and you still have more new messages, you'll see this:
  82.  
  83. *** Your packet is full, but you have more new messages ***
  84.  
  85. Then, unless there were no new messages, the packet will be archived, and
  86. you'll be prompted:
  87.  
  88. Download this packet? (Y/N/G)
  89.  
  90. "Y" and "N" are self-explanatory; "G" stands for "Goodbye after download".
  91. This option will hang up on you after the transfer is completed, with a
  92. ten-second delay in which you can abort the hangup, much like a download
  93. from Searchlight. Unlike some other doors I've seen, this WORKS in Valence,
  94. and I recommend always using the "G" option, unless you have a very small
  95. packet or are on at high speed (so it won't take long).
  96.  
  97. After the above prompt, you'll be asked to choose a protocol if you don't
  98. have one set in the BBS. If you do, you don't have to set it in Valence; it
  99. will use the BBS protocol automatically. However, if you WANT to use a
  100. different protocol for Valence, you have that option, too.
  101.  
  102. If you're using a bidirectional protocol, and you have some .REPs to upload,
  103. you can upload them while downloading, and Valence should process them when
  104. the download is complete. This feature is untested at present, however. (Let
  105. me know if it works!)
  106.  
  107. You also have the option to download multiple packets at once; see below for
  108. details.
  109.  
  110.  
  111. \LB:::: \WHUPLOAD\LB ::::\NO
  112.  
  113. When you select this option, Valence will jump right into the upload -
  114. unless you don't have a protocol selected, in which case it will prompt you
  115. for one, as above. There is no option to hang up after upload, for the
  116. simple reason that I personally have rarely encountered a .REP file much
  117. over 10k, 5k being a more usual size. The file transfer should be over in a
  118. snap, and when your terminal program returns from its protocol display, you
  119. may find your new messages already posted. :-) It's pretty fast. It also is
  120. not very prone to lockups.
  121.  
  122. If you're using a batch protocol, you can upload multiple .REP files in one
  123. transfer. The name can be anything, but the extension must be .REP. (If you
  124. attempt to upload .REPs from another BBS, they will still be rejected; the
  125. filename of the .REP isn't the indicator.) After the transfer, Valence will
  126. AUTODETECT the compression method of each .REP file, instantly, and extract
  127. it with the appropriate program. When processing uploaded .REPs, Valence
  128. doesn't care at all what you have set for your archiver choice and pays no
  129. attention to it whatsoever. You can download with ZIP and upload with ARJ,
  130. for all it cares.
  131.  
  132. Uploaded messages are threaded automatically. "Low-bit" characters, which
  133. cause problems with Searchlight, are converted. (ESC codes, in particular,
  134. are converted to the character <`>, which is recognized by many offline
  135. reader programs as an ESC replacement in ANSI sequences. Thus uploaded ANSI
  136. will be preserved for other QWKers, though not for online reading in
  137. Searchlight.) In echomail subboards, "high-bit" characters are converted,
  138. and "Fido-style" taglines are enforced automatically. You have the option to
  139. switch this on and off for each subboard (echo and non-) individually.
  140.  
  141. ADD, DROP, RESET, and CONFIG control messages are supported. (See below for
  142. details.) Valence will recognize messages adressed to "VALENCE", "QMAIL", or
  143. "SLQWIK" (ugh) as control messages. These messages are not counted in your
  144. "total uploaded messages".
  145.  
  146. When your user record is first created, your subboard list is initialized in
  147. "yucky" mode (q.v.), although the yucky mode flag is set to false. This
  148. allows you to upload packets from older/other QWK doors before doing
  149. anything else - handy if the sysop has installed Valence as a replacement
  150. and deleted the other door.
  151.  
  152. \LB*** Netmail ***\NO
  153.  
  154. Beginning with version 1.1 of Valence, under Searchlight 3.0+ you can send
  155. netmail messages from Valence. Netmail is not really part of the QWK
  156. standard, so it has to be kludged in. To send a netmail message, it must
  157. either be in the MAIL conference or marked as private. The first line in the
  158. text of the message should be either of the form
  159.  
  160. Netmail: 1:379/301
  161.  
  162. or the form
  163.  
  164. @1:379/301
  165.  
  166. The second form is a little more flexible, in that it will also work with
  167. quote-marking characters in front of it; e.g.:
  168.  
  169. WM>@1:379/301
  170.  
  171. The first form mirrors what Valence does to indicate a received netmail
  172. message, so you can reply to a netmail message simply by removing the
  173. quote-marking characters from the first line of the quoted text.
  174.  
  175. Valence's netmail capability is still a little limited. You can't send
  176. Crashmail (a "Yes" to the "Send Immediately?" question that sometimes pops
  177. up in Searchlight's internal netmail function), and the nodelist is not
  178. read, so you need to have the attributes for "originate" and "unlisted" to
  179. send netmail with Valence. Ask your sysop about netmail access.
  180.  
  181. When a netmail message is posted, the first (address) line is removed from
  182. the text, along with the second line if the second line is blank.
  183.  
  184.  
  185. \LB:::: \WHOPTIONS\LB ::::\NO
  186.  
  187. There are altogether too many options in the Options section, but that's
  188. better than too few. Valence allows you substatianial control over the size
  189. and shape of your packet.
  190.  
  191. There are three screens of options. On the first screen, you can can set
  192. your choice of Archiver, Protocol (here you can set new protocols for both
  193. Searchlight and Valence, together or separately), packet size in number of
  194. messages, and ten yes/no options. These options will be explained in more
  195. detail at the end of this file.
  196.  
  197. At each numeric prompt, you'll see a range of numbers in parentheses, along
  198. with another number in brackets. These are the maximum, minimum, and default
  199. values. If you just press <RETURN>, the default will be used.
  200.  
  201. Note that most changes in options can be discarded when you leave the
  202. Options section by answering "N" at the "Save changes?" prompt, BUT, the BBS
  203. protocol selection and Alias name are written to Searchlight's user file at
  204. the time you edit them and are not affected by this prompt.
  205.  
  206. \LB*** ANSI/Translation ***\NO
  207.  
  208. The ANSI/Translation screen allows you to set the default mode Valence uses
  209. in translating messages. By default, all translation is ON. When I first
  210. wrote it, I thought the translation might slow message exporting down a bit,
  211. but there proved to be no detectable difference. Thus you can run with full
  212. Searchlight translation, without overhead. Color codes may be translated to
  213. ANSI, stripped, or simply passed through. Note that translating to ANSI
  214. takes precedence over stripping if both are set to "YES". Metacharacters
  215. (like your name, \%k) may be translated or passed through. The use of
  216. underline characters to join lines may be turned on or off, and this is one
  217. case where I might recommend setting it to "NO", because this feature of
  218. Searchlight is rarely used, and in my own experience I get much more
  219. unintentional wrapping than deliberate, from people using underline chars
  220. for other reasons (as, for instance, to indicate the title of a book).
  221.  
  222. Just as in Searchlight, all translation is also applied to included files,
  223. except - as in Searchlight - for underline joining and including files
  224. (which could lead to infinite recursion). Thus with the default settings,
  225. you should get in your QWK packet just what you would see if you were
  226. reading online in Searchlight.
  227.  
  228. The ANSI wrap is a little feature I had to add when I saw what SLMR did to
  229. the included files that had lines which went over 80 characters. My wrap
  230. will split the lines nicely, and join them with <ESC>[s and <ESC>[u
  231. sequences. This works great for most ANSI pictures, but will mess up ones
  232. that scroll the screen. If your reader will handle long lines, you may want
  233. to reset the wrap length to 255, so they'll all come through correctly. The
  234. wrapping is only applied to included files, not regular text, and only in
  235. QWK mode.
  236.  
  237. There's a special option here to strip flashing codes, for people like me
  238. who find it annoying. Other color codes will be unaffected. Only Searchlight
  239. flashing codes will be removed, not actual ANSI sequences from included
  240. files.
  241.  
  242. The "Color the filelist" option puts NEWFILES.DAT in color. I feel it's a
  243. distinct improvement over plain text, but you might want to leave this off
  244. if your reader doesn't like it (the majority, it seems, don't; SLMR and OLX
  245. do), or to save space, or because you just don't like the color scheme. This
  246. option is ignored in Text packet mode, where the regular ANSI conversion
  247. attributes are checked instead.
  248.  
  249. All translation options are global defaults, and can be reset for each
  250. subboard. You can have some subboards with colors, and some without; some
  251. with metacharacters, and some without. Mix and match any way you like!
  252.  
  253. \LB*** Advanced options ***\NO
  254.  
  255. The first option on this menu is "Alias name". There is a field defined in
  256. the Searchlight user file for this; it's been there for some time, but
  257. Searchlight doesn't use it. Well, now Valence uses it. (I've heard there's
  258. another program out now which uses it, too, but I haven't seen it.) When you
  259. set your alias, Valence will scan the user file to make sure no one else is
  260. using it for either their name or alias. To delete your alias name, just hit
  261. <ENTER> when Valence prompts you for a new name.
  262.  
  263. Valence uses the alias name in two ways: when scanning for new personal
  264. messages, and when posting to an "Anonymous"-allowed subboard, where you can
  265. post with your alias, real name, or "ANONYMOUS". This is a bit of a kludge;
  266. let me know if you have any better ideas on how to implement alias support.
  267.  
  268. The rest of the Advanced options will be explained at the end of the
  269. document.
  270.  
  271.  
  272. \LB:::: \WHSUBLIST\LB ::::\NO
  273.  
  274. The subboard list editor allows you to join, unjoin, mass join/unjoin, set
  275. new high message markers, and set the special options for each subboard that
  276. you have access to. You can page through it easily with the + and - keys.
  277. Most of these options are, I hope, fairly self-explanatory.
  278.  
  279. Note that you are not allowed to unjoin or edit the MAIL subboard, even
  280. though it's displayed. The attributes used for the MAIL subboard are
  281. controlled by the global variables only.
  282.  
  283. Each line of the display in the subboard list shows the number, the name,
  284. the long description, the high message (i.e., your last read message), the
  285. number of the last message in the subboard, and the special attribute list.
  286. This last one looks a little cryptic; the header says "PAHFSCM". These
  287. letters each stand for a flag; there are seven flags packed into a byte for
  288. each subboard. The flags are:
  289.  
  290. \WHP = Personal Only
  291. A = Personal + All ;This takes precedence over P\NO
  292. H = High Bits Allowed
  293. F = Enforce Fido Taglines
  294. S = Strip Color Codes
  295. C = Convert Color Codes
  296. M = Convert Metacharacters
  297.  
  298. The last three, we've already seen under Options. Here you can reset them
  299. for each subboard. Note that these three options are not really active,
  300. UNLESS you explicit set them with the <C>hange attributes command.
  301. Otherwise, the global values are active. There is a hidden eighth bit, the
  302. master bit, which controls whether these three options are checked.
  303.  
  304. \LB*** High bits allowed, Enforce Fido taglines ***\NO
  305.  
  306. These two options are also subject to the master bit. By default, "high-bit"
  307. characters - those in the range 128-255 - are excluded from echomail areas,
  308. and Fido-style taglines are required there. (This is a rule in most Fidonet
  309. echos. Violating it will get you reprimanded by the moderator.) This is
  310. reversed for local subboards.
  311.  
  312. When Valence is asked to translate the high-bit characters in incoming
  313. messages, it does a rapid translation with a lookup table that turns the
  314. high-bits into similar-looking low-bit ones. (This translation is performed
  315. when high bits are allowed, too, to take care of some other problem
  316. characters; Valence just uses a different table then.) To make "Fido-style"
  317. taglines, "tearlines" are converted from "---" to "-=-".
  318.  
  319. What this boils down to is, you don't have to worry about setting Fido-style
  320. taglines in your reader, or using high-bit characters in messages. You can
  321. do as you like, and Valence will take care of it for you. If, however, you
  322. have an echo conference on which high-bit characters ARE allowed, or you
  323. want to change either of these options for a subboard for whatever reason,
  324. the options are here.
  325.  
  326. \LB*** Personal only and Personal/All ***\NO
  327.  
  328. These two options are the most useful. They are not subject to the master
  329. bit; which is to say, you can set either of these without it affecting the
  330. non-preservation of the other attributes.
  331.  
  332. Instead of having to download all the messages on a subboard, you can set
  333. that subboard to scan for just messages adressed to you (and your alias
  334. name, if one is set), or just just messages to you and "ALL". There are two
  335. mass-join features on the main SubList menu to facilitate this; unlike the
  336. <X> toggle option, which only applies to the subboards on the screen before
  337. you, the <P> and <A> options will join ALL unjoined subboards which you have
  338. access to, in either personal or personal/all mode.
  339.  
  340. When Valence is looking for messages to all, it also counts those where the
  341. first four characters of the To: field are "ALL ", OR, the first five
  342. characters of the field are "EVERY". This means it will include messages
  343. adressed to "Everybody", "Everyone", and "All You Zombies" (to quote The
  344. Hooters).
  345.  
  346. Note that when you join a subboard in personal or personal/all mode, you are
  347. genuinely Joined to that subboard, as far as Searchlight is concerned, and
  348. if you then do a New/Joined scan from Searchlight, you'll hit that subboard
  349. (without the benefit of personal/all filtering).
  350.  
  351. All edited attributes will follow the subboards they're attached to if their
  352. conference numbers change.
  353.  
  354. For an amusing display, try the subboard list in "yucky" mode. The numbers
  355. can end up in any order. This is what your CONTROL.DAT file will look like
  356. in yucky mode, too.
  357.  
  358.  
  359. \LB:::: \WHPOINTERS\LB ::::\NO
  360.  
  361. Most other QWK doors only give you one pointer file, but with Valence you
  362. get three for the price of one.
  363.  
  364. A pointer file is a record of the "high message markers" in each conference.
  365. Valence only records the ones it updates. The one with the .PTO extension
  366. contains the old pointers, from before your download; the .PTN file is what
  367. Valence sets them to after a successful download. (The .PTN file is the
  368. actual file read by Valence at the end of a download when it says "Updating
  369. pointers".) The .PTX file is not really a pointer file, but a copy of your
  370. record in Valence's user file, with a character 255 at the beginning to make
  371. it an odd byte length. (Valence detects what type of pointer file you've
  372. uploaded by the length. Uh, this could be a problem if you're using Xmodem,
  373. or another protocol that saves received files in even block lengths. Don't
  374. try uploading a .PTX file with Xmodem; it won't work right. The others
  375. will.)
  376.  
  377. You'll rarely have to use any of these files, or this feature of the menu,
  378. but they're there if you need them. The pointer files are placed first in
  379. the packet, so that if you have a failed transfer, they'll be most likely to
  380. get through.
  381.  
  382. If your packet was corrupted in downloading, but you can still extract the
  383. .PTO file, and Valence thought your transfer went ok and updated your
  384. pointers, (ARGH!) you can upload the .PTO file to put things back the way
  385. they were before the transfer and redownload the messages.
  386.  
  387. If there's a crash on the BBS, and it's restored from yesterday's backup,
  388. and all your message pointers are set back to what they were the day before,
  389. you can upload the .PTN file to avoid rereading.
  390.  
  391. If you get a "The subboard list has been changed since your last download"
  392. message, and you really want to go on and download, but you haven't finished
  393. replying to your last packet yet, go ahead and download. Then go back and
  394. finish replying to the first packet, and upload the .PTX file from it, THEN
  395. the .REP. Then, before you upload your .REP to the new packet, upload the
  396. .PTX file from it. Make sure you keep the .REPs SEPARATE!
  397.  
  398.  
  399. \LB:::: \WHCONTROL MESSAGES\LB ::::\NO
  400.  
  401. These are messages you send to Valence in a .REP to configure it in the same
  402. way as you would online. All the options of online configuration are
  403. available here, with the exception of subboard attributes other than
  404. personal and personal/all. The form of a control message is a message
  405. adressed to "VALENCE", with the subject either "ADD", "DROP", "RESET", or
  406. "CONFIG".
  407.  
  408. "ADD", "DROP", and "RESET" are standard messages which can be generated by
  409. some readers automatically. If you're doing it manually: The message should
  410. be sent in the conference (subboard) to be added, dropped, or reset.
  411. Following the command in the subject for "ADD" and "RESET" may be a number;
  412. this number is the new high message to set for that subboard. If it's
  413. positive, it's an absolute message number; if it's negative, it's an offset
  414. from the last message on the subboard. If no number is given, ADD sets the
  415. high message to 0, and RESET sets it to last message on the subboard. The
  416. ADD command may further be followed by a "Y" to indicate join in personal-
  417. only mode, or a "YA" for join in personal/all.
  418.  
  419. "CONFIG" messages are a little more complicated. These allow you to set all
  420. the options you can set in Valence online, as well as joining and dropping
  421. multiple conferences from within a single message. "CONFIG" is the subject,
  422. and the message may be sent in any conference. Each line of the message
  423. consists of a command keyword, followed by optional parameters. You can use
  424. these keywords in any order, and case is irrelevant. Comments may be added
  425. to the message with semicolons, and blank lines will be ignored. The
  426. commands are as follows... "#" represents a number, brackets indicate an
  427. optional parameter:
  428.  
  429. \YEADD   <conference> [#] [Y] [YA]
  430. DROP  <conference>
  431. RESET <conference> [#]\NO
  432.  
  433. As when used in the subject field, with the addition of the conference
  434. number.
  435.  
  436. \YEMAXSUB   #  ; Maximum number of messages per subboard
  437. MAXTOTAL #  ; Maximum number of messages per packet
  438.  
  439. VPROTO   #  ; Set Valence's protocol to this number
  440. SLPROTO  #  ; Set Searchlight's protocol to this number
  441.  
  442. ARCHIVER  name\NO
  443.  
  444. Set your archiver choice to the one named, if the name is found.
  445.  
  446. \YEALIAS     name  ; Set/reset your alias
  447.  
  448. ANSIWRAP  #     ; Set ANSI wrap length to this number\NO
  449.  
  450. The remainder of the options are "boolean-type". Put a "Y" or "Yes" after
  451. each keyword to set it to "Yes" (true), or a "N" or "No" to set it to "No"
  452. (false).
  453.  
  454. \YEUNDERJOIN   ; Join lines with underline      Default: \WHYes\NO
  455. \YEMETACHARS   ; Replace metacharacters         Default: \WHYes\NO
  456. \YESTRIPCOL    ; Strip color codes              Default: \WHYes\NO
  457. \YEANSICOL     ; Translate color codes to ANSI  Default: \WHYes\NO
  458. \YEFLASHOFF    ; Ignore flashing codes          Default: \LRNo\NO
  459. \YEFILECOLOR   ; Color the filelist             Default: \LRNo\NO
  460. \YEINCLUDE     ; Expand included files          Default: \WHYes\NO
  461.  
  462.  
  463. \LB:::: \WHMORE YES/NO OPTIONS\LB ::::\NO
  464.  
  465. As promised, an explanation of all the unexplained options. These will be
  466. listed both as they appear on the Options screens and with their
  467. CONFIG-message keywords.
  468.  
  469. \YEMARK        ; Mark new messages as read    Default: \WHYes\NO
  470.  
  471. If set to YES, Valence will update the high message pointers in all scanned
  472. subboards, and increment the number of times read of, or delete, each
  473. private MAIL message, after a successful packet download. About the only
  474. reason you'd want to set this to NO is for testing purposes.
  475.  
  476. \YETEXT        ; Text packets instead of QWK  Default: \LRNo\NO
  477.  
  478. Text packets (mentioned above) combine the new bulletins, new messages, and
  479. new files into a single large text (or ANSI) file, and archive it together
  480. with the pointer files and WELCOME/NEWS/GOODBYE/SESSION.TXT files, if those
  481. are selected. Where QWK packets use the extension .QWK, Text packets use the
  482. default extension of the archiver (.ZIP, .ARJ, .LZH, etc.). You won't be
  483. able to reply offline to messages downloaded in Text format. Other than
  484. that, this mode is identical to QWK mode.
  485.  
  486. \YEFILES       ; Include new files listing    Default: \WHYes\NO
  487.  
  488. Valence will scan all directories you have access to, sorted by MAIN.DIR,
  489. for new files, and list any it finds in the file NEWFILES.DAT (or
  490. MESSAGES.TXT in Text mode).
  491.  
  492. \YEBULLETINS   ; Include new bulletins        Default: \WHYes\NO
  493.  
  494. You can leave them out if you want. The only time I'd do that is if the
  495. board I was on was updating ten a day or so, and they were all game high
  496. score files. (I've been in that situation, in fact, but not on a Searchlight
  497. board (so far).) Note these are scanned for by date, and you may have
  498. bulletins being updated without the date being changed. If so, encourage
  499. your sysop to use BUPDATE.EXE, provided with the Valence package.
  500.  
  501. \YENEWONLY     ; DL only new private mail     Default: \LRNo\NO
  502.  
  503. By default, Valence will download all the old junk you've kept online in
  504. your mailbox, as well as the new mail...
  505.  
  506. \YEKILLMAIL    ; Kill private mail after DL   Default: \WHYes\NO
  507.  
  508. ...and then, delete it. You can save it from your reader, which should be
  509. more convenient, and certainly will be more convenient to your sysop. Just
  510. please BE AWARE that this is being done, and don't just discard a packet,
  511. thinking that your old mail is still saved on the BBS.
  512.  
  513. The defaults here are partly to keep the MAIL subboard clean of old
  514. messages, and partly a personal preference, because I too am guilty of
  515. letting huge numbers of messages collect in my Searchlight mailboxes. Or
  516. rather, I used to be; now Valence keeps 'em empty for me. And it works a lot
  517. better than what I used to do: wait until I had a couple dozen accumulated,
  518. then jump to DOS, read them with SLMAIL, archive them, move them to the
  519. uploads directory, return to the BBS, download the archive, kill it, and
  520. purge my mail. Valence does the same thing (and much more) automatically
  521. (and it runs faster than SLMAIL, and purges faster than Searchlight).
  522.  
  523. \YEOWN         ; DL messages FROM yourself    Default: \LRNo\NO
  524.  
  525. The default saves a little space by keeping you from downloading what you
  526. just uploaded.
  527.  
  528. \YEYUCKY       ; Yucky conference numbers     Default: \LRNo\NO
  529.  
  530. OK, this is a BIG one.
  531.  
  532. \LB*** Conference numbers in Valence ***\NO
  533.  
  534. One of the biggest features of Valence is the way it handles conference
  535. numbers. This has been alluded to earlier in this document; here are the
  536. details:
  537.  
  538. Searchlight uses 8-character names (which are DOS filenames) to identify its
  539. subboards. The QWK format uses "conference numbers" to identify each area.
  540. These are matched to names with the CONTROL.DAT text file, but it's the
  541. conference numbers which are used to tell what area a message came from, and
  542. the conference numbers which are used to tell the door what area a reply is
  543. going to. So far, so good; it isn't hard to generate a list of numbers to
  544. match a list of names. But there IS a MAJOR problem here, in that with
  545. Searchlight, a new subboard can be inserted in between two existing ones, or
  546. an old subboard can be deleted, moving the subboards that follow it on the
  547. list up one place. If the subboards are numbered sequentially, then, and
  548. subboards are added or subtracted in between the time you download a packet
  549. and the time you upload a reply, the conference numbers stamped on your
  550. reply messages may no longer be valid. That means the messages you upload
  551. will be posted to the wrong subboards.
  552.  
  553. So, you can't use sequential numbering of the subboards in Searchlight - at
  554. least, not without some trickery. So what DO you do? How do you make a
  555. sensible translation from Searchlight's named subboards to the QWK format's
  556. numbered conferences? ...A translation that will hold up when subboards are
  557. added or deleted?
  558.  
  559. The first solution attempted in a QWK door for Searchlight was SLQWiK's use
  560. of the absolute record number of a subboard in the SUBBOARD.SL2 file (the
  561. master list of subboards). This number won't change, as long as the subboard
  562. exists. If the subboard is removed, it's marked as a deleted record, and the
  563. record numbers don't change. If a new subboard is added, it will be added to
  564. the end or inserted in a previously deleted record.
  565.  
  566. As far as I know, Jack Ridgway hacked this method out himself, which was
  567. pretty clever. It was successful enough that Frank LaRosa then adopted it as
  568. the "official" way of making unchangeable reference numbers, by adding an
  569. "absolute record number" field to the subboard information returned by the
  570. subboard list intializer in the Searchlight Programmer's Library.
  571.  
  572. But this method leaves something to be desired. The numbers you end up with
  573. in CONTROL.DAT are in a random order. This is very ugly, to say the least,
  574. and can mess up some readers. (SLMR, for one, can't make a correct ".MRB"
  575. bookmark file for packets like this. If you come back to reread such a
  576. packet after exiting SLMR, the "Read" markers will be all over the place.)
  577. When I set out to write my own QWK door, this was one of the first things I
  578. wanted to fix. The way I saw it, the subboard list in your reader should
  579. look just like the one you see in Searchlight - sorted by MAIN.SUB, etc. -
  580. with nice sequential numbers in the CONTROL.DAT, and no gaps. And that's
  581. what Valence gives you.
  582.  
  583. Internally, Valence keeps a table of sequential numbers -> absolute record
  584. numbers - one for each user. This list is recalculated every time you select
  585. the "Download" or "SubList" function, and is compared to the stored list. If
  586. it's different, you get the "Subboard list has been changed" warning
  587. message.
  588.  
  589. When you upload a .REP file, the conference numbers in the .REP are
  590. translated back to absolute record numbers, using the stored table from your
  591. last download or edit, and thence to subboard names. Thus the messages will
  592. go the right subboards as surely as if I used absolute record numbers. The
  593. difference here is, you have more opportunity to mess it up, by ignoring the
  594. "Subboard list has been changed" prompt, and then uploading .REPs to
  595. previous packets. I see this as an unlikely scenario (but see above under
  596. POINTERS), although my personal message-reading habits make it more likely
  597. for me than average. :-)
  598.  
  599. When you first enter Valence, it intializes your list to an absolute record
  600. number list, so that you can upload .REPs from other QWK doors as the first
  601. thing you do. After your first download, however, you'll have to set Valence
  602. to "Yucky mode" (ah, finally we come to that) if you want to interchange
  603. .REP files between it and another QWK door.
  604.  
  605. \LB*** Yucky mode ***\NO
  606.  
  607. Yucky mode discards the usual Valence method of generating conference
  608. numbers, and uses absolute record numbers for conference numbers. I call it
  609. that because it's yucky. I don't recommend its use, ever, except if you HAVE
  610. to upload a .REP from another QWK door. You might also use it if you're
  611. paranoid about the possibility of uploading a message into the wrong
  612. subboard. That can't happen in yucky mode (unless you upload replies to a
  613. packet downloaded in NON-yucky mode). It will RARELY happen in Valence ever,
  614. and will NEVER happen if you follow the prompts, but yucky mode offers a
  615. very tiny extra margin of security.
  616.  
  617. \YENUMBERED    ; Numbered packet names        Default: \WHYes\NO
  618.  
  619. This option appends a two-digit number to the name of each of your packets.
  620. The number used is the number of the packet mod 100. My own opinion of
  621. numbered packets is that they're unaesthetic, but useful. I first saw this
  622. feature in SLQWiK, and it's the one point (aside from devising the use of
  623. absolute record numbers) on which I give Jack Ridgway a lot of credit. Note
  624. that unlike SLQWiK, Valence pads numbers below ten out with a zero, so
  625. the packets will sort correctly.
  626.  
  627. If you're doing a non-stop multiple-packet download, and you DON'T have
  628. numbered packets selected, Valence will rename files after the first one in
  629. the form: <BBBSID>.QW0, .QW1... .Q96, .Q97. Valence will in no case allow
  630. you to download more than 99 packets at a time. :-)
  631.  
  632. \YEEMPTY       ; DL packets with no messages  Default: \LRNo\NO
  633.  
  634. Valence will terminate with an error and return to the BBS if this is set to
  635. NO and it finds no new messages. Please note that if you DO have new
  636. *bulletins* or new *files*, Valence will still abort (it won't even scan the
  637. files), so you might want to set this to YES.
  638.  
  639. \YEWELCOME     ; Include Welcome and Goodbye  Default: \WHYes\NO
  640.  
  641. If YES, and these files exist, they will be included in the packet. These
  642. are normally ANSI screens, and default to Searchlight's LOGIN.ANS and
  643. LOGOFF.ANS.
  644.  
  645. \YENEWS        ; Include News file            Default: \WHYes\NO
  646.  
  647. Optional system News file, which the sysop may or may not have implemented.
  648.  
  649. \YEBBDATE      ; New bulletins from BBS date  Default: \LRNo\NO
  650. \YEBFDATE      ; New files from BBS date      Default: \LRNo\NO
  651.  
  652. By default, Valence scans for new files and bulletins, separately, from the
  653. date it last found any, rather than the date you were last on. If you've
  654. ever called a board after a while's absence, logged off or been cut off, and
  655. then realized you didn't see the new files list, but can't remember what
  656. date it was you last called, and now if you call back and do a "New" in
  657. "Files" Searchlight will only scan today's files... you'll appreciate this.
  658.  
  659. But if, on the other hand, you've been calling every day and checking new
  660. files and reading new bulletins, but not always using Valence, you may want
  661. to set these to YES to avoid rereading.
  662.  
  663. The internal dates are intialized with your last on date the first time you
  664. use Valence, so your first download should be the same either way.
  665.  
  666. \YEALLBULLET   ; Download ALL bulletins       Default: \LRNo\NO
  667. \YEALLNEWS     ; ALWAYS include News file     Default: \LRNo\NO
  668.  
  669. If set to YES, it forces these files to be included in your packet whether
  670. they've been updated or not. This may be useful once in a while, especially
  671. for the bulletins.
  672.  
  673. \YESESSION     ; Include SESSION.TXT          Default: \WHYes\NO
  674.  
  675. SESSION.TXT is a simple text file identical to what you see on your screen
  676. while scanning, from the "Copying WELCOME" message on down through the new
  677. files, but without the colors. It may be useful for you to see what messages
  678. you scanned sometimes, but for the most part, this is just a frill (though
  679. part of the QWK standard). It's just a little file, usually, but turning it
  680. off will save you an open file handle while scanning, which can be a help
  681. sometimes. (At the max, Valence has eleven files open at once.)
  682.  
  683. \YEINCREAD     ; Add to number of times read  Default: \LRNo\NO
  684.  
  685. This increments the "number of times read" counter in each message you
  686. download. Perhaps this should be on by default, but it may slow Valence down
  687. slightly, and since that field isn't even used in QWK packets (unless you
  688. turn on "MOREINFO", below), and since another QWK door I tried didn't bother
  689. incrementing them...
  690.  
  691. \YEMULTIPLE    ; Download multiple packets    Default: \LRNo\NO
  692.  
  693. This is a powerful option. When set to YES, whenever you get a "*** Your
  694. packet is full, but you have more new messages ***" message, Valence will
  695. automatically start scanning and packing the next packet after it
  696. successfully sends the first, and will repeat until all new messages are
  697. sent. On scans after the first one, the download prompt is turned off, as
  698. are the bulletins, welcome/goodbye, and new files (since these have already
  699. been scanned), and hangup after download (i.e., after transfer of ALL
  700. packets) is automatically selected. If you only have one packet's worth of
  701. messages, hangup is not automatically selected, and Valence operates just as
  702. it would with this option set to NO.
  703.  
  704. \YEDLPROMPT    ; Prompt for download          Default: \WHYes\NO
  705.  
  706. If this is turned off, the "Download this packet? (Y/N/G)" prompt does not
  707. appear, Valence goes straight to the download, and hangup mode is
  708. automatically selected. It also replaces the "The subboard list...Proceed?
  709. (Y/N)" prompt with a message: "Warning: The subboard list has been changed.
  710. Old .REPs may be invalid", and goes right on with the download, so I really
  711. advise against using this option.
  712.  
  713. \YEBLANKLIST   ; Show empty areas in scan     Default: \LRNo\NO
  714.  
  715. Shows all areas scanned, even if there's nothing new in them.
  716.  
  717. \YEMANYNUM     ; A lot of numbers in scan     Default: \LRNo\NO
  718.  
  719. In scanning for new messages, Valence will list First Msg, Last Msg, Last
  720. Read, New Last, Extracted, and Personal. This takes precendence over "wordy"
  721. mode. It has no effect in scanning files. This is my personal preference,
  722. but it seems to be Too Many Numbers for some people. :-)
  723.  
  724. \YEWORDY       ; Area descriptions in scan    Default: \WHYes\NO
  725.  
  726. This prints the area descriptions when scanning new messages (if not
  727. overridden by manynum) and new files. If off, only the area name and number
  728. extracted (and personal) will be shown.
  729.  
  730. \YEWRAPFILES   ; Wrap filelist into 40 cols   Default: \WHYes\NO
  731.  
  732. Instead of having one short file description line of 40 characters followed
  733. by two lines of 60 characters, you can have 4 lines (approximately) of 40
  734. characters each, all neatly aligned. Try it, I think you'll like it. But it
  735. does make for a larger NEWFILES.DAT than the non-wrapping mode.
  736.  
  737. \YEEXTRALN1    ; Blank line after long descs  Default: \WHYes\NO
  738.  
  739. This, the default mode, is like Searchlight's internal file listing:
  740. single-line descriptions run together, while multi-line descriptions have a
  741. blank line between them.
  742.  
  743. \YEEXTRALN2    ; Blank line after each file   Default: \LRNo\NO
  744.  
  745. A different way to do it.
  746.  
  747. \YEFULLSUBJ    ; Full subject in text         Default: \WHYes\NO
  748.  
  749. Searchlight's subject lines are up to 40 characters long; the QWK format is
  750. limited to 25. If, and only if, a message's subject is over 25 characters
  751. long, Valence will by default include it in the first line of the message
  752. with the word "Subject: ", and a blank line afterwards. Valence will also do
  753. this ALWAYS for "Fwd Fm:" and received netmail (which Searchlight prints as
  754. "Origin:" but Valence prints as "Netmail:").
  755.  
  756. Also, if a subject line starts with a "Re: ", "RE: ", or "(R) ", Valence
  757. will automatically strip it out, both to save space in the subject field and
  758. fit more of the originial subject in, and to allow better sorting of
  759. messages by subject. (SLMR does this automatically, and it works distinctly
  760. better since I added "Re: " stripping.) There is no option to turn this off
  761. (sorry). The "Re: " will not be stripped out of the long subject line in the
  762. body of the text, nor in Text mode.
  763.  
  764. \YEMOREINFO    ; Even more info in text       Default: \LRNo\NO
  765.  
  766. This adds a line, like the ones just mentioned, into the body of the QWK
  767. message, listing number of times read, number of replies, and whether the
  768. message has been imported or exported.
  769.  
  770. Together, these two keywords cover all the "extra" information in the
  771. Searchlight message header. Neither has any affect in Text packet mode.
  772. Headers in Text packets are identical to Searchlight's display, apart from
  773. the colors.
  774.  
  775. \YEDISORDER    ; Ignore subboard list file    Default: \LRNo\NO
  776. \YEFDISORDER   ; Ignore directory list file   Default: \LRNo\NO
  777.  
  778. Ordinarily, Valence, like Searchlight, reads the files MAIN.SUB and MAIN.DIR
  779. and sorts the subboard and file directory lists, respectively, according to
  780. these files. You can turn this off if you want.
  781.  
  782. \YEPERSINDEX   ; Include personal index file  Default: \WHYes\NO
  783.  
  784. You can turn off the PERSONAL.NDX file (saving another of those eleven open
  785. files), and you won't have a "Personal" conference in your reader (or you'll
  786. have an empty one). The only reason this option is here is because I
  787. remember seeing it in Qmail (? I think), and it was trivial to implement.
  788.  
  789. \YEBRANDNEW    ; You haven't DLed yet         Default: \BLSee below\NO
  790.  
  791. This is normally a one-shot option; it's set to YES when you enter Valence
  792. for the first time, to tell it to send you THIS FILE (and the intro message
  793. in MAIL), and then set the option to NO. If you ever want to receive this
  794. file over again, you can set the option to YES.
  795.  
  796. \YEJOINED      ; Only joined subs in sublist  Default: \LRNo\NO
  797.  
  798. This will shrink your CONTROL.DAT somewhat if you turn it on, and may make
  799. for a neater display in your reader (though it will make gaps between
  800. conference numbers appear), but it will prevent you from joining any
  801. unjoined subboards offline, except with the "CONFIG" message method.
  802.  
  803.  
  804. \LB:::: \WHSOMETHING NOT TO DO\BL ::::\NO
  805.  
  806. For all you masochists out there, to make Valence functionally equivalent to
  807. SLQWiK, set these options:
  808.  
  809. UNDERJOIN No
  810. METACHARS No
  811. STRIPCOL  No
  812. ANSICOL   No
  813. FILECOLOR No
  814. INCLUDE   No
  815. BULLETINS No
  816. NEWONLY   Yes
  817. KILLMAIL  No
  818. YUCKY     Yes
  819. WELCOME   No
  820. NEWS      No
  821. SESSION   No
  822. WRAPFILES No
  823. FULLSUBJ  No
  824. DISORDER  Yes
  825. FDISORDER Yes
  826.  
  827. Sorry, there's no way I know to make Valence slow down and lock up
  828. frequently. :-)
  829.